home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilSpatialImg.z / ilSpatialImg
Encoding:
Text File  |  2002-10-03  |  18.0 KB  |  330 lines
  1.  
  2.  
  3.  
  4. iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg - Base class for spatial operator images
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilSpatialImg is the base class for spatial operator images.  ilSpatialImg
  19.      has a pure virtual member function and thus cannot be created as an
  20.      object.  It is intended to be used to derive spatial operator images.
  21.      However, a pointer to an ilSpatialImg can be declared.
  22.  
  23.      ilSpatialImg handles the messy details of allocating a working buffer and
  24.      reading input data based on the size of the kernel being used and the
  25.      current edge mode. The edge mode specifies how to handle pixels along the
  26.      edge of a page. For example, additional input data can be used to compute
  27.      a full page. In this case, the amount of additional input data read
  28.      depends on the size of the kernel being used.
  29.  
  30.      UUUUssssiiiinnnngggg iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg
  31.      Spatial operators compute a result based on a local neighborhood of
  32.      pixels.  The size of the kernel being used determines the size of the
  33.      neighborhood.  Therefore, the size of the kernel must be known to compute
  34.      the size of the working buffer.
  35.  
  36.      The edge mode determines how pixels along the edge of the image are
  37.      handled. By default, additional input data is read to allow pixels along
  38.      the edge to be computed. Several edge modes are supported such as
  39.      _i_l_P_a_d_S_r_c, _i_l_P_a_d_D_s_t, _i_l_N_o_P_a_d, _i_l_W_r_a_p and _i_l_R_e_f_l_e_c_t.
  40.  
  41.      For more details see iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttEEEEddddggggeeeeMMMMooooddddeeee().
  42.  
  43.      In addition, an offset table, _k_e_r_n_O_f_f, and a value table, _k_e_r_n_V_a_l, are
  44.      built based on the input kernel specified. The offset table contains
  45.      offsets into the input buffer to access data corresponding to nonzero
  46.      kernel elements.  The value table contains the nonzero kernel elements
  47.      and corresponds to the offset table. These tables are provided for
  48.      convenience to derived classes that choose to use them.
  49.  
  50.  
  51. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  52.      SSSSeeeettttttttiiiinnnngggg ssssppppaaaattttiiiiaaaallll ooooppppeeeerrrraaaattttoooorrrr ppppaaaarrrraaaammmmeeeetttteeeerrrrssss
  53.  
  54.           void ilSpatialImgSetDynamicKernel(ilSpatialImg* img, ilKernel* kernel)
  55.           void ilSpatialImgSetEdgeMode(ilSpatialImg* img, ilEdgeMode eMode)
  56.           void ilSpatialImgSetKernel(ilSpatialImg* img, ilKernel* kern)
  57.           void ilSpatialImgSetKernelSize(ilSpatialImg* img, int x, int y, int z)
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))
  70.  
  71.  
  72.  
  73.      QQQQuuuueeeerrrryyyyiiiinnnngggg ssssppppaaaattttiiiiaaaallll ooooppppeeeerrrraaaattttoooorrrr ppppaaaarrrraaaammmmeeeetttteeeerrrrssss
  74.  
  75.           ilEdgeMode ilSpatialImgGetEdgeMode(ilSpatialImg *img)
  76.           ilKernel* ilSpatialImgGetKernel(ilSpatialImg* img)
  77.           void ilSpatialImgGetKernelSize3D(ilSpatialImg *img, int *x, int *y,
  78.                                            int *z)
  79.           void ilSpatialImgGetKernelSize(ilSpatialImg *img, int *x, int *y)
  80.  
  81.  
  82. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  83.      ggggeeeettttEEEEddddggggeeeeMMMMooooddddeeee(((())))
  84.  
  85.           ilEdgeMode ilSpatialImgGetEdgeMode(ilSpatialImg *img)
  86.  
  87.  
  88.           Returns the current edge mode as the enumerated type ilEdgeMode. See
  89.           also iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttEEEEddddggggeeeeMMMMooooddddeeee().
  90.  
  91.      ggggeeeettttKKKKeeeerrrrnnnneeeellll(((())))
  92.  
  93.           ilKernel *ilSpatialImgGetKernel(ilSpatialImg *obj)
  94.  
  95.  
  96.           This function returns the current input kernel value.
  97.  
  98.      ggggeeeettttKKKKeeeerrrrnnnneeeellllSSSSiiiizzzzeeee(((())))
  99.  
  100.           void ilSpatialImgGetKernelSize(ilSpatialImg *img, int *x, int *y)
  101.           void ilSpatialImgGetKernelSize3D(ilSpatialImg *img, int *x, int *y, int *z)
  102.  
  103.  
  104.           This function is overloaded to conveniently handle the 2D case. It
  105.           returns the current kernel size in _x, _y, and optionally, _z. See also
  106.           iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttKKKKeeeerrrrnnnneeeellllSSSSiiiizzzzeeee().
  107.  
  108.      sssseeeettttDDDDyyyynnnnaaaammmmiiiiccccKKKKeeeerrrrnnnneeeellll(((())))
  109.  
  110.           void ilSpatialImgSetDynamicKernel(ilKernel* kern)
  111.  
  112.  
  113.           This functions sets this objects input kernel to the ilKernel
  114.           pointed to by _k_e_r_n. This function differs from iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttKKKKeeeerrrrnnnneeeellll
  115.           in that this ilSpatialImg object will watch for changes to the input
  116.           kernel.
  117.  
  118.      sssseeeettttEEEEddddggggeeeeMMMMooooddddeeee(((())))
  119.  
  120.           void ilSpatialImgSetEdgeMode(ilSpatialImg *img, ilEdgeMode eMode)
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))
  136.  
  137.  
  138.  
  139.           This function sets the edge mode to the enumerated type _i_l_E_d_g_e_M_o_d_e
  140.           specified by _e_M_o_d_e. The edge mode specifies how to handle pixels
  141.           along the edge of the image. Spatial operators process a
  142.           neighborhood of input pixels defined by the kernel. Therefore,
  143.           output pixels within half the kernel size along the edge of the
  144.           image, do not have enough input data to be computed. This situation
  145.           can be handled in many ways as specified by the edge mode. Several
  146.           edge modes are supported such as: _i_l_P_a_d_S_r_c, _i_l_P_a_d_D_s_t, _i_l_N_o_P_a_d,
  147.           _i_l_W_r_a_p and _i_l_R_e_f_l_e_c_t.  The default edge mode is _i_l_P_a_d_S_r_c.
  148.  
  149.           For _i_l_P_a_d_S_r_c (pad source), extra input data is read, which allows
  150.           pixels near the edge to be processed. The amount of extra data read
  151.           depends on the kernel size in each dimension. The requested input
  152.           data is filled as needed near the edge of the image, with the
  153.           current _f_i_l_l_V_a_l_u_e.
  154.  
  155.           For _i_l_P_a_d_D_s_t (pad destination), the border along the edge of the
  156.           image is filled with its _f_i_l_l_V_a_l_u_e. This is done because the
  157.           resultant image is smaller than the input image by the kernel size
  158.           in each dimension.
  159.  
  160.           For _i_l_N_o_P_a_d (no pad), nothing is done about the borders and the
  161.           resulting image is reduced in size by the size of the kernel in each
  162.           dimension causing a shift toward the origin.
  163.  
  164.           For _i_l_W_r_a_p, data from the opposite edge in the source image is used
  165.           to fill in missing data along the edges.  The amount of data wrapped
  166.           depends on the size of the kernel in each dimension.
  167.  
  168.           For _i_l_R_e_f_l_e_c_t, data near an edge is reflected and used to fill in
  169.           missing data along the edges.  The amount of data reflected depends
  170.           on the size of the kernel in each dimension.
  171.  
  172.      sssseeeettttKKKKeeeerrrrnnnneeeellll(((())))
  173.  
  174.           void ilSpatialImgSetKernel(ilSpatialImg *img, ilKernel *kern)
  175.  
  176.  
  177.           This function sets the input kernel to the ilKernel pointed to by
  178.           _k_e_r_n. The default value is NULL. This function calls
  179.           iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttKKKKeeeerrrrnnnneeeellllSSSSiiiizzzzeeee() to update the size of the kernel.
  180.  
  181.      sssseeeettttKKKKeeeerrrrnnnneeeellllSSSSiiiizzzzeeee(((())))
  182.  
  183.           void ilSpatialImgSetKernelSize(ilSpatialImg *img, int x, int y, int z)
  184.  
  185.  
  186.           The x, y and z size of the kernel are set to _x, _y and _z.  This
  187.           function also sets the minimum page size based on the size of the
  188.           kernel. It is set to a multiple of the kernel size to enhance
  189.           efficiency.  iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmggggSSSSeeeettttKKKKeeeerrrrnnnneeeellllSSSSiiiizzzzeeee()
  190.  
  191.  
  192.  
  193.  
  194.                                                                         PPPPaaaaggggeeee 3333
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201. iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))
  202.  
  203.  
  204.  
  205. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  206.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  207.      ilOpImgClearClamp(), ilOpImgGetBias(), ilOpImgGetClamp(),
  208.      ilOpImgGetValidOrders(), ilOpImgGetValidTypes(), ilOpImgIsClamped(),
  209.      ilOpImgIsPrecisionKept(), ilOpImgKeepPrecision(), ilOpImgSetBias(),
  210.      ilOpImgSetClampMinMax(), ilOpImgSetClamp()
  211.  
  212.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  213.      ilMemCacheImgEnableMP(), ilMemCacheImgGetPageTime(),
  214.      ilMemCacheImgGetRetainMode(), ilMemCacheImgGetThrashMode(),
  215.      ilMemCacheImgGetThrashTime(), ilMemCacheImgGetTotalPageTime(),
  216.      ilMemCacheImgIsMPenabled(), ilMemCacheImgSetRetainMode(),
  217.      ilMemCacheImgSetThrashMode()
  218.  
  219.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  220.      ilCacheImgFlush(), ilCacheImgGetCacheSize()
  221.  
  222.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  223.      ilAddInput(), ilAllocFillData(), ilClipTile(), ilClipTileAsTile(),
  224.      ilClipTileFloat(), ilClipTileFloatAsTile(),
  225.      ilConfigureRetainedCacheImage(), ilCopy(), ilCopyTile(), ilCopyTile3D(),
  226.      ilCopyTileCfg(), ilFillTile(), ilFillTile3D(), ilFillTileRGB(),
  227.      ilFreeFillData(), ilGetColorImg(), ilGetColorModel(), ilGetColormap(),
  228.      ilGetColormapPtr(), ilGetCompression(), ilGetConfig(), ilGetCsize(),
  229.      ilGetDataType(), ilGetDimensions(), ilGetDirectInput(),
  230.      ilGetDisplayCacheEnable(), ilGetFill(), ilGetFillData(),
  231.      ilGetFillValue(), ilGetHeight(), ilGetHwEnable(), ilGetHwHint(),
  232.      ilGetHwHintName(), ilGetHwIntHint(), ilGetHwIntHintName(), ilGetInput(),
  233.      ilGetInputTileRequirement(), ilGetLockTileSet(), ilGetMappedPageSize(),
  234.      ilGetMappedSize(), ilGetMaxColormapLevels(), ilGetMaxValue(),
  235.      ilGetMinValue(), ilGetNumChans(), ilGetNumInputs(), ilGetOrder(),
  236.      ilGetOrientation(), ilGetPageBorder(), ilGetPageBorderPtr(),
  237.      ilGetPageBorderX(), ilGetPageBorderY(), ilGetPageBorderZ(),
  238.      ilGetPageCounts(), ilGetPageDelta(), ilGetPageDeltaStruct(),
  239.      ilGetPageDimensions(), ilGetPageIndices(), ilGetPageOrigin(),
  240.      ilGetPageOriginC(), ilGetPageOriginStruct(), ilGetPageOriginX(),
  241.      ilGetPageOriginY(), ilGetPageOriginZ(), ilGetPageSize(),
  242.      ilGetPageSizeBytes(), ilGetPageSizeC(), ilGetPageSizePix(),
  243.      ilGetPageSizeStruct(), ilGetPageSizeVal(), ilGetPageSizeX(),
  244.      ilGetPageSizeXY(), ilGetPageSizeY(), ilGetPageSizeZ(), ilGetPixel(),
  245.      ilGetPixel3D(), ilGetPriority(), ilGetScaleMax(), ilGetScaleMin(),
  246.      ilGetSize(), ilGetSizePtr(), ilGetStrides(), ilGetSubTile(),
  247.      ilGetSubTile3D(), ilGetTile(), ilGetTile3D(), ilGetWidth(), ilGetXsize(),
  248.      ilGetYsize(), ilGetZsize(), ilHasPageBorder(), ilHasPages(),
  249.      ilInitScaleMinMax(), ilIsColorImg(), ilIsIntegral(),
  250.      ilIsMirrorOrientation(), ilIsSigned(), ilIsWritable(), ilLockPage(),
  251.      ilLockPageSet(), ilLockTile(), ilLockTile3D(), ilMapFlipTrans(),
  252.      ilMapFromInput(), ilMapFromInput2D(), ilMapFromInput3D(),
  253.      ilMapFromSource(), ilMapFromSource2D(), ilMapFromSource3D(),
  254.      ilMapOrientation(), ilMapSize(), ilMapTile(), ilMapTileFlipTrans(),
  255.      ilMapTileFloat(), ilMapToInput(), ilMapToInput2D(), ilMapToInput3D(),
  256.      ilMapToSource(), ilMapToSource2D(), ilMapToSource3D(), ilMapXY(),
  257.  
  258.  
  259.  
  260.                                                                         PPPPaaaaggggeeee 4444
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267. iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))    IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll    iiiillllSSSSppppaaaattttiiiiaaaallllIIIImmmmgggg((((3333))))
  268.  
  269.  
  270.  
  271.      ilMapXYFloat(), ilMapXYSign(), ilQCopyTileCfg(), ilQFillTile3D(),
  272.      ilQFillTileRGB(), ilQGetSubTile3D(), ilQGetTile3D(), ilQLockPageSet(),
  273.      ilQSetSubTile3D(), ilQSetTile3D(), ilRemoveHwHint(),
  274.      ilRemoveHwHintName(), ilRemoveInput(), ilSetColorModel(),
  275.      ilSetColormap(), ilSetCompression(), ilSetCsize(), ilSetDataType(),
  276.      ilSetDisplayCacheEnable(), ilSetFill(), ilSetFillValue(),
  277.      ilSetHwEnable(), ilSetHwHint(), ilSetHwIntHint(), ilSetHwIntHintName(),
  278.      ilSetInput(), ilSetMaxColormapLevels(), ilSetMaxValue(), ilSetMinValue(),
  279.      ilSetNumChans(), ilSetOrder(), ilSetOrientation(), ilSetPageBorder(),
  280.      ilSetPageBorderStruct(), ilSetPageSize(), ilSetPageSizeC(),
  281.      ilSetPageSizeStruct(), ilSetPageSizeXY(), ilSetPageSizeZ(), ilSetPixel(),
  282.      ilSetPixel3D(), ilSetPriority(), ilSetScaleMinMax(), ilSetScaleType(),
  283.      ilSetSize(), ilSetSubTile(), ilSetSubTile3D(), ilSetTile(),
  284.      ilSetTile3D(), ilSetXYsize(), ilSetXsize(), ilSetYsize(), ilSetZsize(),
  285.      ilUnlockPage(), ilUnlockPageSet()
  286.  
  287.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  288.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  289.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  290.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  291.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  292.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  293.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  294.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  295.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  296.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  297.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  298.  
  299. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  300.      ilImage, ilCache, ilOpImg
  301.  
  302. NNNNOOOOTTTTEEEESSSS
  303.      If _w_T_y_p_e is different from _d_t_y_p_e, then the derived class must convert the
  304.      data type between the input buffer and the output buffer.
  305.  
  306.      Note that an even-sized kernel causes a half-pixel shift away from the
  307.      origin because the center of the kernel is _b_e_t_w_e_e_n the center elements.
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.                                                                         PPPPaaaaggggeeee 5555
  327.  
  328.  
  329.  
  330.